<html>
	<head>
		<title>pipeline</title>
<link href="../docs-assets/Breadcrumbs.css" rel="stylesheet" rev="stylesheet" type="text/css">
		<meta name="viewport" content="width=device-width initial-scale=1">
		<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
		<meta http-equiv="Content-Language" content="en-gb">

<link href="../docs-assets/Contents.css" rel="stylesheet" rev="stylesheet" type="text/css">
<link href="../docs-assets/Progress.css" rel="stylesheet" rev="stylesheet" type="text/css">
<link href="../docs-assets/Navigation.css" rel="stylesheet" rev="stylesheet" type="text/css">
<link href="../docs-assets/Fonts.css" rel="stylesheet" rev="stylesheet" type="text/css">
<link href="../docs-assets/Base.css" rel="stylesheet" rev="stylesheet" type="text/css">
		
	</head>
	<body class="commentary-font">
		<nav role="navigation">
		<h1><a href="../index.html"><img src="../docs-assets/Inform.png" height=72> </a></h1>
<ul><li><a href="../index.html">home</a></li>
</ul><h2>Compiler</h2><ul>
<li><a href="../structure.html">structure</a></li>
<li><a href="../inbuildn.html">inbuild</a></li>
<li><a href="../inform7n.html">inform7</a></li>
<li><a href="../intern.html">inter</a></li>
<li><a href="../services.html">services</a></li>
<li><a href="../secrets.html">secrets</a></li>
</ul><h2>Other Tools</h2><ul>
<li><a href="../inblorbn.html">inblorb</a></li>
<li><a href="../inform6.html">inform6</a></li>
<li><a href="../inpolicyn.html">inpolicy</a></li>
</ul><h2>Resources</h2><ul>
<li><a href="../extensions.html">extensions</a></li>
<li><a href="../kits.html">kits</a></li>
</ul><h2>Repository</h2><ul>
<li><a href="https://github.com/ganelson/inform"><img src="../docs-assets/github.png" height=0> github</a></li>
</ul><h2>Related Projects</h2><ul>
<li><a href="https://github.com/ganelson/inweb"><img src="../docs-assets/github.png" height=0> inweb</a></li>
<li><a href="https://github.com/ganelson/intest"><img src="../docs-assets/github.png" height=0> intest</a></li>
</ul>
		</nav>
		<main role="main">
		<ul class="crumbs"><li><a href="../index.html">Home</a></li><li><a href="../intern.html">Inter Modules</a></li><li><b>pipeline</b></li></ul>
		<p class="purpose">The code generation pipeline. This is version 1.</p>
		<hr>
		<div class="contentspage">
			<ul class="chapterlist">
				<li>
					<p class="chapterentry"><a name="P"></a>
						<span class="chaptertitle">Preliminaries</span></p>
					<ul class="sectionlist">
						<li>
							<p class="sectionentry"><a href="P-wtmd.html">
								<spon class="sectiontitle">What This Module Does</span></a> -
							<span class="sectionpurpose">An overview of the pipeline module's role and abilities.</span></p>
						</li>
					</ul>
				</li>
				<li>
					<p class="chapterentry"><a name="1"></a>
						<span class="chaptertitle">Chapter 1: Setting Up</span></p>
					<ul class="sectionlist">
						<li>
							<p class="sectionentry"><a href="1-pm.html">
								<spon class="sectiontitle">Pipeline Module</span></a> -
							<span class="sectionpurpose">Setting up the use of this module.</span></p>
						</li>
					</ul>
				</li>
				<li>
					<p class="chapterentry"><a name="2"></a>
						<span class="chaptertitle">Chapter 2: Pipelines</span></p>
					<ul class="sectionlist">
						<li>
							<p class="sectionentry"><a href="2-pp.html">
								<spon class="sectiontitle">Parsing Pipelines</span></a> -
							<span class="sectionpurpose">To parse pipelines from text files.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="2-rp.html">
								<spon class="sectiontitle">Running Pipelines</span></a> -
							<span class="sectionpurpose">To run through pipelines of code generation stages.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="2-pe.html">
								<spon class="sectiontitle">Pipeline Errors</span></a> -
							<span class="sectionpurpose">To issue problem messages when parsing or running erroneous pipelines.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="2-ns.html">
								<spon class="sectiontitle">New Stage</span></a> -
							<span class="sectionpurpose">This stage takes an empty tree and equips it with just the absolute basics, so that it is ready to have substantive material added at a later stage.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="2-rmss.html">
								<spon class="sectiontitle">Read, Move, Stop Stages</span></a> -
							<span class="sectionpurpose">Four simple pipeline stages.</span></p>
						</li>
					</ul>
				</li>
				<li>
					<p class="chapterentry"><a name="3"></a>
						<span class="chaptertitle">Chapter 3: Assimilation</span></p>
					<ul class="sectionlist">
						<li>
							<p class="sectionentry"><a href="3-ps.html">
								<spon class="sectiontitle">Parsing Stages</span></a> -
							<span class="sectionpurpose">Two stages which accept raw I6-syntax material in the parse tree, either from insertions made using Inform 7's low-level features, or after reading the source code for a kit.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="3-rccs.html">
								<spon class="sectiontitle">Resolve Conditional Compilation Stage</span></a> -
							<span class="sectionpurpose">To generate the initial state of storage for variables.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="3-css.html">
								<spon class="sectiontitle">Compile Splats Stage</span></a> -
							<span class="sectionpurpose">To replace each splat node with a sequence of pure Inter nodes having the same meaning, thus purging the tree of all raw I6 syntax entirely.</span></p>
						</li>
					</ul>
				</li>
				<li>
					<p class="chapterentry"><a name="4"></a>
						<span class="chaptertitle">Chapter 4: Linking</span></p>
					<ul class="sectionlist">
						<li>
							<p class="sectionentry"><a href="4-lbks.html">
								<spon class="sectiontitle">Load Binary Kits Stage</span></a> -
							<span class="sectionpurpose">Reading other Inter trees as binary files, and attaching them at given points in the main Inter tree.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="4-sws.html">
								<spon class="sectiontitle">Shorten Wiring Stage</span></a> -
							<span class="sectionpurpose">To catch missing resources with suitable errors, to remove plugs and sockets as no longer necessary, and to shorten wiring as much as possible.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="4-dics.html">
								<spon class="sectiontitle">Detect Indirect Calls Stage</span></a> -
							<span class="sectionpurpose">To handle function calls made to functions identified by symbols which turn out, during linking, to be variables rather than constants.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="4-mius.html">
								<spon class="sectiontitle">Make Identifiers Unique Stage</span></a> -
							<span class="sectionpurpose">To make sure certain symbol names translate into globally unique target symbols.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="4-rvs.html">
								<spon class="sectiontitle">Reconcile Verbs Stage</span></a> -
							<span class="sectionpurpose">To reconcile clashes between assimilated and originally generated verbs.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="4-tsk.html">
								<spon class="sectiontitle">The Standard Kits</span></a> -
							<span class="sectionpurpose">The layout and naming conventions for functions and other resources provided by the standard kits, and which are called or accessed from code generated by Inter or by the Inform 7 compiler.</span></p>
						</li>
					</ul>
				</li>
				<li>
					<p class="chapterentry"><a name="5"></a>
						<span class="chaptertitle">Chapter 5: Synoptic Module</span></p>
					<ul class="sectionlist">
						<li>
							<p class="sectionentry"><a href="5-msms.html">
								<spon class="sectiontitle">Make Synoptic Module Stage</span></a> -
							<span class="sectionpurpose">Creating a top-level module of synoptic resources.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="5-sh.html">
								<spon class="sectiontitle">Synoptic Hierarchy</span></a> -
							<span class="sectionpurpose">The layout and naming conventions for the contents of the main/synoptic module.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="5-su.html">
								<spon class="sectiontitle">Synoptic Utilities</span></a> -
							<span class="sectionpurpose">Utility functions for generating the code in the synoptic module.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="5-ext.html">
								<spon class="sectiontitle">Extensions</span></a> -
							<span class="sectionpurpose">To renumber the extensions and construct suitable functions and arrays.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="5-lt.html">
								<spon class="sectiontitle">Literal Text</span></a> -
							<span class="sectionpurpose">To alphabetise literal texts, deduplicate them, and store a canonical set in the synoptic/texts submodule.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="5-rsp.html">
								<spon class="sectiontitle">Responses</span></a> -
							<span class="sectionpurpose">To compile the main/synoptic/responses submodule.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="5-rls.html">
								<spon class="sectiontitle">Rules</span></a> -
							<span class="sectionpurpose">To compile the main/synoptic/rules and main/synoptic/rulebooks submodules.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="5-act.html">
								<spon class="sectiontitle">Activities</span></a> -
							<span class="sectionpurpose">To compile the main/synoptic/activities submodule.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="5-act2.html">
								<spon class="sectiontitle">Actions</span></a> -
							<span class="sectionpurpose">To compile the main/synoptic/actions submodule.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="5-ins.html">
								<spon class="sectiontitle">Instances</span></a> -
							<span class="sectionpurpose">To compile the main/synoptic/instances submodule.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="5-dlg.html">
								<spon class="sectiontitle">Dialogue</span></a> -
							<span class="sectionpurpose">To compile the main/synoptic/dialogue submodule.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="5-knd.html">
								<spon class="sectiontitle">Kinds</span></a> -
							<span class="sectionpurpose">To compile the main/synoptic/kinds submodule.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="5-prp.html">
								<spon class="sectiontitle">Properties</span></a> -
							<span class="sectionpurpose">To compile the main/synoptic/properties submodule.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="5-rlt.html">
								<spon class="sectiontitle">Relations</span></a> -
							<span class="sectionpurpose">To compile the main/synoptic/relations submodule.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="5-tbl.html">
								<spon class="sectiontitle">Tables</span></a> -
							<span class="sectionpurpose">To compile the main/synoptic/tables submodule.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="5-chr.html">
								<spon class="sectiontitle">Chronology</span></a> -
							<span class="sectionpurpose">To compile the main/synoptic/chronology submodule.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="5-scn.html">
								<spon class="sectiontitle">Scenes</span></a> -
							<span class="sectionpurpose">To compile the main/synoptic/scenes submodule.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="5-mlt.html">
								<spon class="sectiontitle">Multimedia</span></a> -
							<span class="sectionpurpose">To compile the main/synoptic/multimedia submodule.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="5-uo.html">
								<spon class="sectiontitle">Use Options</span></a> -
							<span class="sectionpurpose">To compile the main/synoptic/use_options submodule.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="5-vrb.html">
								<spon class="sectiontitle">Verbs</span></a> -
							<span class="sectionpurpose">To compile the main/synoptic/verbs submodule.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="5-tst.html">
								<spon class="sectiontitle">Tests</span></a> -
							<span class="sectionpurpose">To compile the main/synoptic/tests submodule.</span></p>
						</li>
					</ul>
				</li>
				<li>
					<p class="chapterentry"><a name="6"></a>
						<span class="chaptertitle">Chapter 6: Optimisation</span></p>
					<ul class="sectionlist">
						<li>
							<p class="sectionentry"><a href="6-erms.html">
								<spon class="sectiontitle">Eliminate Redundant Matter Stage</span></a> -
							<span class="sectionpurpose">To remove definitions which are never used: for example, functions which are never called or referred to.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="6-erls.html">
								<spon class="sectiontitle">Eliminate Redundant Labels Stage</span></a> -
							<span class="sectionpurpose">To remove labels which are defined but never jumped to.</span></p>
						</li>
						<li>
							<p class="sectionentry"><a href="6-eros.html">
								<spon class="sectiontitle">Eliminate Redundant Operations Stage</span></a> -
							<span class="sectionpurpose">To remove logical or arithmetic operations which neither do anything, nor have side-effects.</span></p>
						</li>
					</ul>
				</li>
			</ul>
		</div>
		<hr>
		<p class="purpose">Powered by <a href="https://github.com/ganelson/inweb">Inweb</a>.</p>
		</main>
	</body>
</html>

